home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / telecomm / bbs / wwbbs.lha / WWBBS / WWBBS.doc < prev    next >
Text File  |  1994-10-16  |  12KB  |  488 lines
  1. World Wide BBS 2.3 (16.10.94)
  2. Copyright © 1994 Arthur Choung
  3. ---
  4. Main Features:
  5.  
  6.      o Is a commodity.
  7.  
  8.      o Has nice GUI, thanks to triton.library.
  9.  
  10.      o Everything runs through stdio, so every program you can run through
  11.        the shell you can run through the BBS.
  12.  
  13. Requirements:
  14.  
  15.      o Kickstart 2.04, but the higher the better.
  16.  
  17.      o ARexx
  18.  
  19.      o triton.library
  20.  
  21. Optional:
  22.  
  23.      o OwnDevUnit.library
  24.  
  25.  
  26. Installation
  27. ---
  28.  
  29.      Double-click on the Install icon.
  30.  
  31.      If you are upgrading from an older version, please read the file
  32. History.doc to brief you on the program's changes.
  33.  
  34.  
  35. Using WWBBS
  36. ---
  37.  
  38.      Double-click on the WWBBS icon.  It has all the properties that a
  39. commodity has.
  40.  
  41.      On the top-left is the node list.  You can double-click on a local
  42. node to logon, and on a remote node when a user is online to open a viewing
  43. console.
  44.  
  45.      On the top-right is the action list.  You can click on an action, and
  46. it will execute that command.  You can also pass along the currently
  47. selected node to that command.  This is configurable through the tool
  48. types.  For every action to add, put in this line in this format:
  49.  
  50.      ACTION=<Name>,<Command>
  51.  
  52.           Name=Name of action to put in listview
  53.           Command=Full path of command to execute.  If you would like to
  54.                   pass along the node, substitute a "%s" (including quotes)
  55.                   and it will pass along the node's id.
  56.  
  57.      Note that when you click on the close window gadget, it does not quit
  58. the program because it is a commodity.  Also when doing substition type
  59. arguments such as in Command above, always include quotes unless otherwise
  60. noted.
  61.  
  62.  
  63. Using BBSPrefs
  64. ---
  65.  
  66.      Double-click on the BBSPrefs icon.  It is a normal program.  Note that
  67. some of the windows opened in this program are pretty big so you may need a
  68. larger screen if the window won't open up.
  69.  
  70.      There are eleven sub-prefs.  They include:
  71.  
  72.           Access Groups
  73.                These are the access groups you can select for a
  74.                user.
  75.  
  76.           Archivers
  77.                These are the archivers that the user can choose from.
  78.  
  79.           Door Variables
  80.                All of these variables are set as local environment
  81.                variables that the can be read by the programs run from the
  82.                bbs.
  83.  
  84.           Editors
  85.                These are the editors that the user can choose from.
  86.  
  87.           File Bases
  88.                These are the file bases.
  89.  
  90.           Menus
  91.                This is the menu tree.
  92.  
  93.           Message Bases
  94.                These are the message bases.
  95.  
  96.           News
  97.                These are the news file to inform the user of any changes.
  98.  
  99.           Nodes
  100.                These are the node configurations.
  101.  
  102.           Protocols
  103.                These are the protocols that the user can choose fom.
  104.  
  105.           System
  106.                These are options that configure the entire system.
  107.  
  108.      There are basically two types of prefs.  One has a list of items you
  109. can edit, and the other allows you to create a tree, as in sub-directories.
  110. File Base Prefs, Menu Prefs, and Message Base Prefs fall into the latter
  111. category.  You can use the arrow keys to navigate the tree.  System Prefs
  112. is different from all the other prefs in that there are only options to
  113. set, and no list.
  114.  
  115.  
  116. Using AccessGroupPrefs
  117. ---
  118.  
  119. These are the fields:
  120.  
  121.      Access Level
  122.           This is the access level of the user.  0 is equivalent to being
  123.           banned from the bbs, 1 is a new user, and 255 is the almighty
  124.           sysop.
  125.  
  126.      Session Time Limit
  127.           In minutes.
  128.  
  129.      Inactivity Time Limit
  130.           In minutes.
  131.  
  132.      Ratio Byte
  133.           Byte ratio for the file base.  0 is no ratio.
  134.  
  135.      Ratio File
  136.           File ratio for the file base.  0 is no ratio.
  137.  
  138.      Days
  139.           Number of days of inactivity before being deleted by UserMaint.
  140.  
  141.  
  142. Using ArchiverPrefs
  143. ---
  144.  
  145.      Extension
  146.           Archiver extension so it can be identified.
  147.  
  148.      Add Command
  149.           Full path of command to run, substituting "%a" for the archive
  150.           and "%f" for the file to be added.
  151.  
  152.      Extract Command
  153.           Full path of command to run, substituting "%s" for the archive.
  154.  
  155.      View Command
  156.           Full path of command to run, substituting "%s" for the archive.
  157.  
  158.  
  159. Using DoorVarPrefs
  160. ---
  161.  
  162.      String
  163.           Sets the variable specified by its name to whatever is in this
  164.           string.  You can substitute, all are self-explanatory:
  165.  
  166.                @BAUD
  167.                @NODENAME
  168.                @USERNAME
  169.                @REALNAME
  170.                @UUCPNAME
  171.                @HOMEDIR
  172.                @ACCESSLEVEL
  173.                @SCREENWIDTH
  174.                @SCREENHEIGHT
  175.                @EDITOR
  176.  
  177.  
  178. Using EditorPrefs
  179. ---
  180.  
  181.      Type
  182.           Standard is any normal editor which runs through the shell and
  183.           does not need ANSI.  Visual is like standard but for editors that
  184.           need ANSI.  Graphical is for local users so you can run your
  185.           favorite editor.
  186.  
  187.      Command
  188.           Full path of command to run.  The file name will be appended.
  189.  
  190.      Stack
  191.           Stack size to give command.
  192.  
  193.  
  194. Using FileBasePrefs
  195. ---
  196.  
  197.      Access Range
  198.           Range of access levels to accept, using commands and dashes.  For
  199.           example, 1-255 means everything between 1 and 255, including 1
  200.           and 255, 1-5,255 means one through five and 255, etc.
  201.  
  202.      Group
  203.           ID name of group.  Try to keep these simple, no spaces and
  204.           lowercase letters.  Try names them with a usenet style heirarchy.
  205.           For example, util, util.disk, util.wb, etc.
  206.  
  207.      Directory
  208.           Directory to use for this group.
  209.  
  210.      Disk Space Required
  211.           Disk space required for upload in kilobytes.
  212.  
  213.      Days
  214.           How many days of inactivity before deleting files by FileMaint.
  215.  
  216.      Read Only
  217.           No uploading.
  218.  
  219.      Auto Join
  220.           Automatically join this group for new users.
  221.  
  222.  
  223. Using MenuPrefs
  224. ---
  225.  
  226.      Access Range
  227.  
  228.      Character
  229.           Character of the command.
  230.  
  231.      Default
  232.           For menus with sub-menus.  When you press return this command
  233.           will be executed.
  234.  
  235.      Number
  236.           For menus with sub-menus.  When you press a digit this command
  237.           will be executed and the digit will be passed along.
  238.  
  239.      Prompt
  240.           For menus with sub-menus.  This is the prompt to print.  You can
  241.           use \e to pass ESC, \t for TAB, \b for BS, \n for newline, \f to
  242.           clear screen, and %t for time remaining.  No quotes are needed.
  243.  
  244.      Command
  245.           For normal menu items.  You can specify ABBEREXX commands and
  246.           System commands.
  247.  
  248.      When displaying a menu, WWBBS will first search for
  249. "WWBBS:Menus/{menu name>.<ascii|ansi>", and if it exists, it will display
  250. it.  Otherwise it will just show the standard menu.  For example, an ansi
  251. user in the main menu will see "WWBBS:Menus/Main.ansi", if it exists.
  252.     When creating custom menu files, you can add keycodes to hide certain
  253. menu items from users according to their access level.  At the beginning of
  254. a line, put:
  255.  
  256.           @<accesslevel range>@
  257.  
  258. For example, @1-128,255@ will show this line to users with accesslevels in
  259. the range of 1 to 128, and 255.
  260.  
  261.  
  262. Using MessageBasePrefs
  263. ---
  264.  
  265.      Access Range
  266.  
  267.      Group
  268.           ID name of group.  Internal use only.
  269.  
  270.      Quote Header
  271.           Quote header for replies.  Substitute %d for date, %t for time,
  272.           %n for name, no quotes needed.
  273.  
  274.      Read Only
  275.  
  276.      Auto Join
  277.  
  278.  
  279. Using NewsPrefs
  280. ---
  281.  
  282.      Access Range
  283.  
  284.      File
  285.           File to show user.
  286.  
  287.      Date
  288.  
  289.  
  290. Using NodePrefs
  291. ---
  292.  
  293.      Access Range
  294.  
  295.      Type
  296.           Local is for use locally.  Remote is for remote use.
  297.  
  298.      Device
  299.           For remote nodes only.  Device to use.
  300.  
  301.      Unit
  302.           For remote nodes only.  Unit of device to use.
  303.  
  304.      Buffer Size
  305.           For remote nodes only.  Buffer Size to allocate.
  306.  
  307.      Baud
  308.           For remote nodes only.  Baud rate.
  309.  
  310.      Handshaking
  311.           For remote nodes only.  RTS/CTS handshaking.
  312.  
  313.      Auto Baud
  314.           For remote nodes only.  When answering call, should you change
  315.           baud rate to match?  For error-detecting/compression modems, you
  316.           should not set this.
  317.  
  318.      Front End
  319.           For remote nodes only.  Use StartSession to start a session from
  320.           TrapDoor or UUCICO.
  321.  
  322.      Command
  323.           Command to execute for each session.  Remember that anything that
  324.           runs through shell can be used here.  You should provide a delay
  325.           of about three seconds on remote nodes to allow other side to do
  326.           whatever it needs to do.
  327.  
  328.  
  329. Using ProtocolPrefs
  330. ---
  331.  
  332.      Send Command
  333.      Receive Command
  334.           Command to execute.  Substitute:
  335.                "%d" for device name.
  336.                %u for device unit.
  337.                %l for unique log file name.
  338.                %F for input file list.
  339.                %f for file name.
  340.                %n for user name.
  341.  
  342.      Batch
  343.           Protocol handles batch transfers.
  344.  
  345.      Bidirectional
  346.           Protocol handlers bidirectional transfers.
  347.  
  348.  
  349. Using SystemPrefs
  350. ---
  351.  
  352.      Display Mode
  353.           Display mode of console.
  354.  
  355.      Font
  356.           Font of console
  357.  
  358.      Log Days
  359.           Number of days to keep logs before being filtered out by LogMaint.
  360.  
  361.      Offline Directory
  362.           Put files here by FileMaint for offline files.
  363.  
  364.      Only Real Names
  365.           Don't allow aliases.
  366.  
  367.      Header Color
  368.      Input Color
  369.      Output Color
  370.      Prompt Color
  371.      System Color
  372.           String for <fill> color.  Send \e for ESC, \t for TAB, \b for BS,
  373.           \n for newline, \f to clear screen.
  374.  
  375.  
  376. Using Editor
  377. ---
  378.  
  379.      Simple editor.  Usage:
  380.  
  381.           Editor <file name>
  382.  
  383.  
  384. Using ForceLogOff
  385. ---
  386.  
  387.      Run by WWBBS as an action.  Usage:
  388.  
  389.           ForceLogOff <node id>
  390.  
  391.  
  392. Using LogMaint
  393. ---
  394.  
  395.      Just run it to trim logs.
  396.  
  397.  
  398. Using LogViewer
  399. ---
  400.  
  401.      Figure it out.
  402.  
  403.  
  404. Using BBSRx
  405. ---
  406.  
  407.      This runs .rexx files while interpreting ABBEREXX and System
  408. commands...see the appropriate doc files for a list of commands.
  409.  
  410.      The template is:
  411.  
  412.           BBSRx FILE/A
  413.  
  414.  
  415. Using StartSession
  416. ---
  417.  
  418.      Use this in conjunction with TrapDoor and UUCICO.  Usage:
  419.  
  420.           StartSession <node> [-BAUD <baud>]
  421.  
  422.  
  423. Using UserEditor
  424. ---
  425.  
  426.      See LogViewer.
  427.  
  428.  
  429. Using UserMaint
  430. ---
  431.  
  432.      Just run it to trim users.
  433.  
  434.  
  435. Using XPR
  436. ---
  437.  
  438.      This tool handles XPR transfers.  Usage:
  439.  
  440.           Command/R,D=Device/K,U=Unit/N,L=Library/K/R,I=Init/K,Log/K,
  441.           FL=FileList/K,FN=FileName/K,ID=UserID/K,RES=Resume/S
  442.  
  443.      Where:
  444.  
  445.           Command:  S=Send or R=Receive
  446.           Device:   serial device, default is "serial.device"
  447.           Unit:     unit, default is 0
  448.           Library:  xpr.library
  449.           Init:     init string, if not specified, will use ENVARC:
  450.           Log:      name of log file (DSZ-style)
  451.           FileList: name of file list for batch send*
  452.           FileName: name of file for single file send
  453.           UserID:   use with resume
  454.           Resume:   if result is supported, all aborted files (receive)
  455.                     have a id tag attached to them.  otherwise they are
  456.                     deleted.
  457.  
  458.      * A file list is a text file with one filename per line.
  459.  
  460.  
  461. History
  462. ---
  463.  
  464.      There has been so many changes from 1.0 to 2.0 I can't list them.  2.0
  465. has been basically redesigned and for all intents and purposes, rewritten.
  466. For users who do have 1.0 you should delete it from existence and install
  467. 2.0 from scratch.  The config file is now expandable so this is the last
  468. time.
  469.  
  470.  
  471. Author
  472. ---
  473.  
  474.      This program is freeware.  If you would like to contact me:
  475.  
  476.           Usenet: arthur@qedbbs.com
  477.           US Mail: 10324 Chestnut Street, Bellflower, CA 90706 USA
  478.  
  479.      To those who sent me mail I am sorry that I did not respond to them,
  480. but it seemed that most of them referred to old versions of WWBBS.  When
  481. mailing me please tell me which version of WWBBS you are using.
  482.  
  483.      I also have a new address.  I should be able to respond more quickly
  484. as this one is on the internet.
  485.  
  486.           Internet: choung@seas.ucla.edu
  487.  
  488.